﻿<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <link rel="stylesheet" href="../assets/css/yui-cssgrids-min.css">
    <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
    <link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
    <link rel="shortcut icon" type="image/x-icon" href="../assets/favicon.ico">
    <script src="../assets/js/yui-source.js"></script>
	<title>EaselJS v1.0.0 API Documentation : Container</title>
</head>
<body class="yui3-skin-sam">

<div id="doc">
    <div id="hd" class="yui3-g header">
        <div class="yui3-u-3-4">
            
                <h1><a href="http://createjs.site/easeljs"><img src="../assets/docs-icon-EaselJS.png" title="EaselJS"></a></h1>
            
        </div>
        <div class="version">
            <em>API Documentation for: 1.0.0</em>
        </div>
    </div>
    <div id="bd" class="yui3-g">

        <div class="yui3-u-1-4">
            <div id="docs-sidebar" class="sidebar apidocs">
                <div id="api-list">
    <h2 class="off-left">APIs</h2>
    <div id="api-tabview" class="tabview">
        <ul class="tabs">
            <li><a href="#api-classes">Classes</a></li>
        </ul>

        <div id="api-tabview-filter">
            <input type="search" id="api-filter" placeholder="Type to filter APIs">
        </div>

        <div id="api-tabview-panel">
            <ul id="api-classes" class="apis classes">
            
                <li><a href="AlphaMapFilter.html">AlphaMapFilter</a></li>
            
                <li><a href="AlphaMaskFilter.html">AlphaMaskFilter</a></li>
            
                <li><a href="Bitmap.html">Bitmap</a></li>
            
                <li><a href="BitmapCache.html">BitmapCache</a></li>
            
                <li><a href="BitmapText.html">BitmapText</a></li>
            
                <li><a href="BlurFilter.html">BlurFilter</a></li>
            
                <li><a href="ButtonHelper.html">ButtonHelper</a></li>
            
                <li><a href="ColorFilter.html">ColorFilter</a></li>
            
                <li><a href="ColorMatrix.html">ColorMatrix</a></li>
            
                <li><a href="ColorMatrixFilter.html">ColorMatrixFilter</a></li>
            
                <li><a href="Container.html">Container</a></li>
            
                <li><a href="DisplayObject.html">DisplayObject</a></li>
            
                <li><a href="DisplayProps.html">DisplayProps</a></li>
            
                <li><a href="DOMElement.html">DOMElement</a></li>
            
                <li><a href="EaselJS.html">EaselJS</a></li>
            
                <li><a href="Event.html">Event</a></li>
            
                <li><a href="EventDispatcher.html">EventDispatcher</a></li>
            
                <li><a href="Filter.html">Filter</a></li>
            
                <li><a href="Graphics.html">Graphics</a></li>
            
                <li><a href="Graphics.Arc.html">Graphics.Arc</a></li>
            
                <li><a href="Graphics.ArcTo.html">Graphics.ArcTo</a></li>
            
                <li><a href="Graphics.BeginPath.html">Graphics.BeginPath</a></li>
            
                <li><a href="Graphics.BezierCurveTo.html">Graphics.BezierCurveTo</a></li>
            
                <li><a href="Graphics.Circle.html">Graphics.Circle</a></li>
            
                <li><a href="Graphics.ClosePath.html">Graphics.ClosePath</a></li>
            
                <li><a href="Graphics.Ellipse.html">Graphics.Ellipse</a></li>
            
                <li><a href="Graphics.Fill.html">Graphics.Fill</a></li>
            
                <li><a href="Graphics.LineTo.html">Graphics.LineTo</a></li>
            
                <li><a href="Graphics.MoveTo.html">Graphics.MoveTo</a></li>
            
                <li><a href="Graphics.PolyStar.html">Graphics.PolyStar</a></li>
            
                <li><a href="Graphics.QuadraticCurveTo.html">Graphics.QuadraticCurveTo</a></li>
            
                <li><a href="Graphics.Rect.html">Graphics.Rect</a></li>
            
                <li><a href="Graphics.RoundRect.html">Graphics.RoundRect</a></li>
            
                <li><a href="Graphics.Stroke.html">Graphics.Stroke</a></li>
            
                <li><a href="Graphics.StrokeDash.html">Graphics.StrokeDash</a></li>
            
                <li><a href="Graphics.StrokeStyle.html">Graphics.StrokeStyle</a></li>
            
                <li><a href="Matrix2D.html">Matrix2D</a></li>
            
                <li><a href="MouseEvent.html">MouseEvent</a></li>
            
                <li><a href="MovieClip.html">MovieClip</a></li>
            
                <li><a href="MovieClipPlugin.html">MovieClipPlugin</a></li>
            
                <li><a href="Point.html">Point</a></li>
            
                <li><a href="Rectangle.html">Rectangle</a></li>
            
                <li><a href="Shadow.html">Shadow</a></li>
            
                <li><a href="Shape.html">Shape</a></li>
            
                <li><a href="Sprite.html">Sprite</a></li>
            
                <li><a href="SpriteSheet.html">SpriteSheet</a></li>
            
                <li><a href="SpriteSheetBuilder.html">SpriteSheetBuilder</a></li>
            
                <li><a href="SpriteSheetUtils.html">SpriteSheetUtils</a></li>
            
                <li><a href="Stage.html">Stage</a></li>
            
                <li><a href="StageGL.html">StageGL</a></li>
            
                <li><a href="Text.html">Text</a></li>
            
                <li><a href="Ticker.html">Ticker</a></li>
            
                <li><a href="Touch.html">Touch</a></li>
            
                <li><a href="UID.html">UID</a></li>
            
                <li><a href="Utility%20Methods.html">Utility Methods</a></li>
            
                <li><a href="VideoBuffer.html">VideoBuffer</a></li>
            
                <li><a href="WebGLInspector.html">WebGLInspector</a></li>
            
            </ul>

            <ul id="api-modules" class="apis modules">
            
                <li><a href="../modules/CreateJS.html">CreateJS</a></li>
            
                <li><a href="../modules/EaselJS.html">EaselJS</a></li>
            
            </ul>
        </div>
    </div>
</div>

            </div>
        </div>
        <div class="yui3-u-3-4">
            <div id="api-options">
        Show:
        <label for="api-show-inherited">
            <input type="checkbox" id="api-show-inherited" checked="">
            Inherited
        </label>

        <label for="api-show-protected">
            <input type="checkbox" id="api-show-protected">
            Protected
        </label>

        <label for="api-show-private">
            <input type="checkbox" id="api-show-private">
            Private
        </label>
        <label for="api-show-deprecated">
            <input type="checkbox" id="api-show-deprecated">
            Deprecated
        </label>

    </div>
            <div class="apidocs">
                <div id="docs-main">
                    <div class="content">
                        <h1>Container Class</h1>
<div class="box meta">
    

    
        <div class="extends">
            Extends <a href="DisplayObject.html" class="crosslink">DisplayObject</a>
        </div>
    

    
        <div class="foundat">
            Defined in: <a href="../files/easeljs_display_Container.js.html#l37"><code>Container:37</code></a>
        </div>
    

    
        
            Module: <a href="../modules/EaselJS.html">EaselJS</a>
        
    

    
</div>



<div class="box intro">
    <p>A Container is a nestable display list that allows you to work with compound display elements. For  example you could
group arm, leg, torso and head <a href="Bitmap.html" class="crosslink">Bitmap</a> instances together into a Person Container, and
transform them as a group, while still being able to move the individual parts relative to each other. Children of
containers have their <code>transform</code> and <code>alpha</code> properties concatenated with their parent Container.</p>
<p>For example, a <a href="Shape.html" class="crosslink">Shape</a> with <code>x=100</code> and <code>alpha=0.5</code>, placed in a Container with <code>x=50</code>
and <code>alpha=0.7</code> will be rendered to the canvas at <code>x=150</code> and <code>alpha=0.35</code>. Containers have some overhead, so you
generally shouldn&#39;t create a Container to hold a single child.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code> var container = new createjs.Container();
 container.addChild(bitmapInstance, shapeInstance);
 container.x = 100;</code></pre>

</div>


    <div class="constructor">
        <h2>Constructor</h2>
        <div id="method_Container" class="method item">
    <h3 class="name"><code>Container</code></h3>

    
        <span class="paren">()</span>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l37"><code>Container:37</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        
    </div>

    

    

    
</div>

    </div>


<div id="classdocs" class="tabview">
    <ul class="api-class-tabs">
        <li class="api-class-tab index"><a href="#index">Index</a></li>

        
            <li class="api-class-tab methods"><a href="#methods">Methods</a></li>
        
        
            <li class="api-class-tab properties"><a href="#properties">Properties</a></li>
        
        
        
            <li class="api-class-tab events"><a href="#events">Events</a></li>
        
    </ul>

    <div>
        <div id="index" class="api-class-tabpanel index">
            <h2 class="off-left">Item Index</h2>

            
                <div class="index-section methods">
                    <h3>Methods</h3>

                    <ul class="index-list methods extends">
                        
                            <li class="index-item method protected inherited">
                                <a href="#method__applyShadow">_applyShadow</a>

                                
                                
                            </li>
                        
                            <li class="index-item method protected inherited">
                                <a href="#method__cloneProps">_cloneProps</a>

                                
                                
                            </li>
                        
                            <li class="index-item method protected inherited">
                                <a href="#method__dispatchEvent">_dispatchEvent</a>

                                
                                
                            </li>
                        
                            <li class="index-item method protected inherited">
                                <a href="#method__getBounds">_getBounds</a>

                                
                                
                            </li>
                        
                            <li class="index-item method protected">
                                <a href="#method__getNumChildren">_getNumChildren</a>

                                
                                
                            </li>
                        
                            <li class="index-item method protected">
                                <a href="#method__getObjectsUnderPoint">_getObjectsUnderPoint</a>

                                
                                
                            </li>
                        
                            <li class="index-item method protected inherited">
                                <a href="#method__getStage">_getStage</a>

                                
                                
                            </li>
                        
                            <li class="index-item method protected inherited">
                                <a href="#method__isMouseOpaque">_isMouseOpaque</a>

                                
                                
                            </li>
                        
                            <li class="index-item method protected inherited">
                                <a href="#method__testHit">_testHit</a>

                                
                                
                            </li>
                        
                            <li class="index-item method protected">
                                <a href="#method__testMask">_testMask</a>

                                
                                
                            </li>
                        
                            <li class="index-item method protected inherited">
                                <a href="#method__tick">_tick</a>

                                
                                
                            </li>
                        
                            <li class="index-item method protected inherited">
                                <a href="#method__transformBounds">_transformBounds</a>

                                
                                
                            </li>
                        
                            <li class="index-item method protected inherited">
                                <a href="#method__updateState">_updateState</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_addChild">addChild</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_addChildAt">addChildAt</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_addEventListener">addEventListener</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_cache">cache</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_clone">clone</a>

                                
                                
                            </li>
                        
                            <li class="index-item method protected">
                                <a href="#method_cloneChildren">cloneChildren</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_contains">contains</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_dispatchEvent">dispatchEvent</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_draw">draw</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_getBounds">getBounds</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_getCacheDataURL">getCacheDataURL</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_getChildAt">getChildAt</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_getChildByName">getChildByName</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_getChildIndex">getChildIndex</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_getConcatenatedDisplayProps">getConcatenatedDisplayProps</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_getConcatenatedMatrix">getConcatenatedMatrix</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_getMatrix">getMatrix</a>

                                
                                
                            </li>
                        
                            <li class="index-item method deprecated">
                                <a href="#method_getNumChildren">getNumChildren</a>

                                
                                
                                    <span class="flag deprecated">deprecated</span>
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_getObjectsUnderPoint">getObjectsUnderPoint</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_getObjectUnderPoint">getObjectUnderPoint</a>

                                
                                
                            </li>
                        
                            <li class="index-item method deprecated inherited">
                                <a href="#method_getStage">getStage</a>

                                
                                
                                    <span class="flag deprecated">deprecated</span>
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_getTransformedBounds">getTransformedBounds</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_globalToLocal">globalToLocal</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_hasEventListener">hasEventListener</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_hitTest">hitTest</a>

                                
                                
                            </li>
                        
                            <li class="index-item method deprecated">
                                <a href="#method_initialize">initialize</a>

                                
                                
                                    <span class="flag deprecated">deprecated</span>
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_isVisible">isVisible</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_localToGlobal">localToGlobal</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_localToLocal">localToLocal</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_off">off</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_on">on</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_removeAllChildren">removeAllChildren</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_removeAllEventListeners">removeAllEventListeners</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_removeChild">removeChild</a>

                                
                                
                            </li>
                        
                            <li class="index-item method protected">
                                <a href="#method_removeChildAt">removeChildAt</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_removeChildAt">removeChildAt</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_removeEventListener">removeEventListener</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_set">set</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_setBounds">setBounds</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_setChildIndex">setChildIndex</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_setTransform">setTransform</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_sortChildren">sortChildren</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_swapChildren">swapChildren</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_swapChildrenAt">swapChildrenAt</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_toString">toString</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_uncache">uncache</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_updateCache">updateCache</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_updateContext">updateContext</a>

                                
                                
                            </li>
                        
                            <li class="index-item method inherited">
                                <a href="#method_willTrigger">willTrigger</a>

                                
                                
                            </li>
                        
                    </ul>
                </div>
            

            
                <div class="index-section properties">
                    <h3>Properties</h3>

                    <ul class="index-list properties extends">
                        
                            <li class="index-item property protected inherited">
                                <a href="#property__bounds">_bounds</a>

                                
                                
                            </li>
                        
                            <li class="index-item property protected deprecated inherited">
                                <a href="#property__cacheDataURL">_cacheDataURL</a>

                                
                                
                                    <span class="flag deprecated">deprecated</span>
                                
                            </li>
                        
                            <li class="index-item property protected deprecated inherited">
                                <a href="#property__cacheDataURLID">_cacheDataURLID</a>

                                
                                
                                    <span class="flag deprecated">deprecated</span>
                                
                            </li>
                        
                            <li class="index-item property protected deprecated inherited">
                                <a href="#property__cacheScale">_cacheScale</a>

                                
                                
                                    <span class="flag deprecated">deprecated</span>
                                
                            </li>
                        
                            <li class="index-item property protected inherited">
                                <a href="#property__captureListeners">_captureListeners</a>

                                
                                
                            </li>
                        
                            <li class="index-item property protected inherited">
                                <a href="#property__listeners">_listeners</a>

                                
                                
                            </li>
                        
                            <li class="index-item property protected inherited">
                                <a href="#property__props">_props</a>

                                
                                
                            </li>
                        
                            <li class="index-item property protected inherited">
                                <a href="#property__rectangle">_rectangle</a>

                                
                                
                            </li>
                        
                            <li class="index-item property protected inherited">
                                <a href="#property__webGLRenderStyle">_webGLRenderStyle</a>

                                
                                
                            </li>
                        
                            <li class="index-item property inherited">
                                <a href="#property_alpha">alpha</a>

                                
                                
                            </li>
                        
                            <li class="index-item property inherited">
                                <a href="#property_bitmapCache">bitmapCache</a>

                                
                                
                            </li>
                        
                            <li class="index-item property inherited">
                                <a href="#property_cacheCanvas">cacheCanvas</a>

                                
                                
                            </li>
                        
                            <li class="index-item property deprecated inherited">
                                <a href="#property_cacheID">cacheID</a>

                                
                                
                                    <span class="flag deprecated">deprecated</span>
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_children">children</a>

                                
                                
                            </li>
                        
                            <li class="index-item property inherited">
                                <a href="#property_compositeOperation">compositeOperation</a>

                                
                                
                            </li>
                        
                            <li class="index-item property inherited">
                                <a href="#property_cursor">cursor</a>

                                
                                
                            </li>
                        
                            <li class="index-item property inherited">
                                <a href="#property_filters">filters</a>

                                
                                
                            </li>
                        
                            <li class="index-item property inherited">
                                <a href="#property_hitArea">hitArea</a>

                                
                                
                            </li>
                        
                            <li class="index-item property inherited">
                                <a href="#property_id">id</a>

                                
                                
                            </li>
                        
                            <li class="index-item property inherited">
                                <a href="#property_mask">mask</a>

                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_mouseChildren">mouseChildren</a>

                                
                                
                            </li>
                        
                            <li class="index-item property inherited">
                                <a href="#property_mouseEnabled">mouseEnabled</a>

                                
                                
                            </li>
                        
                            <li class="index-item property inherited">
                                <a href="#property_name">name</a>

                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_numChildren">numChildren</a>

                                
                                
                            </li>
                        
                            <li class="index-item property inherited">
                                <a href="#property_parent">parent</a>

                                
                                
                            </li>
                        
                            <li class="index-item property inherited">
                                <a href="#property_regX">regX</a>

                                
                                
                            </li>
                        
                            <li class="index-item property inherited">
                                <a href="#property_regY">regY</a>

                                
                                
                            </li>
                        
                            <li class="index-item property inherited">
                                <a href="#property_rotation">rotation</a>

                                
                                
                            </li>
                        
                            <li class="index-item property inherited">
                                <a href="#property_scale">scale</a>

                                
                                
                            </li>
                        
                            <li class="index-item property inherited">
                                <a href="#property_scaleX">scaleX</a>

                                
                                
                            </li>
                        
                            <li class="index-item property inherited">
                                <a href="#property_scaleY">scaleY</a>

                                
                                
                            </li>
                        
                            <li class="index-item property inherited">
                                <a href="#property_shadow">shadow</a>

                                
                                
                            </li>
                        
                            <li class="index-item property inherited">
                                <a href="#property_skewX">skewX</a>

                                
                                
                            </li>
                        
                            <li class="index-item property inherited">
                                <a href="#property_skewY">skewY</a>

                                
                                
                            </li>
                        
                            <li class="index-item property inherited">
                                <a href="#property_snapToPixel">snapToPixel</a>

                                
                                
                            </li>
                        
                            <li class="index-item property inherited">
                                <a href="#property_stage">stage</a>

                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_tickChildren">tickChildren</a>

                                
                                
                            </li>
                        
                            <li class="index-item property inherited">
                                <a href="#property_tickEnabled">tickEnabled</a>

                                
                                
                            </li>
                        
                            <li class="index-item property inherited">
                                <a href="#property_transformMatrix">transformMatrix</a>

                                
                                
                            </li>
                        
                            <li class="index-item property inherited">
                                <a href="#property_visible">visible</a>

                                
                                
                            </li>
                        
                            <li class="index-item property inherited">
                                <a href="#property_x">x</a>

                                
                                
                            </li>
                        
                            <li class="index-item property inherited">
                                <a href="#property_y">y</a>

                                
                                
                            </li>
                        
                    </ul>
                </div>
            

            

            
                <div class="index-section events">
                    <h3>Events</h3>

                    <ul class="index-list events extends">
                        
                            <li class="index-item event inherited">
                                <a href="#event_added">added</a>

                                
                                
                            </li>
                        
                            <li class="index-item event inherited">
                                <a href="#event_click">click</a>

                                
                                
                            </li>
                        
                            <li class="index-item event inherited">
                                <a href="#event_dblclick">dblclick</a>

                                
                                
                            </li>
                        
                            <li class="index-item event inherited">
                                <a href="#event_mousedown">mousedown</a>

                                
                                
                            </li>
                        
                            <li class="index-item event inherited">
                                <a href="#event_mouseout">mouseout</a>

                                
                                
                            </li>
                        
                            <li class="index-item event inherited">
                                <a href="#event_mouseover">mouseover</a>

                                
                                
                            </li>
                        
                            <li class="index-item event inherited">
                                <a href="#event_pressmove">pressmove</a>

                                
                                
                            </li>
                        
                            <li class="index-item event inherited">
                                <a href="#event_pressup">pressup</a>

                                
                                
                            </li>
                        
                            <li class="index-item event inherited">
                                <a href="#event_removed">removed</a>

                                
                                
                            </li>
                        
                            <li class="index-item event inherited">
                                <a href="#event_rollout">rollout</a>

                                
                                
                            </li>
                        
                            <li class="index-item event inherited">
                                <a href="#event_rollover">rollover</a>

                                
                                
                            </li>
                        
                            <li class="index-item event inherited">
                                <a href="#event_tick">tick</a>

                                
                                
                            </li>
                        
                    </ul>
                </div>
            
        </div>

        
            <div id="methods" class="api-class-tabpanel">
                <h2 class="off-left">Methods</h2>

                
                    <div id="method__applyShadow" class="method item protected inherited">
    <h3 class="name"><code>_applyShadow</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>ctx</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>shadow</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#method__applyShadow">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l1273"><code>_applyShadow:1273</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">ctx</code>
                        <span class="type">CanvasRenderingContext2D</span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">shadow</code>
                        <span class="type"><a href="Shadow.html" class="crosslink">Shadow</a></span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method__cloneProps" class="method item protected inherited">
    <h3 class="name"><code>_cloneProps</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>o</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>
        </span>
    

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#method__cloneProps">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l1240"><code>_cloneProps:1240</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">o</code>
                        <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>
                    

                    

                    <div class="param-description">
                        <p>The DisplayObject instance which will have properties from the current DisplayObject
instance copied into.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>:
                    
                    <p>o</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method__dispatchEvent" class="method item protected inherited">
    <h3 class="name"><code>_dispatchEvent</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>eventObj</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>eventPhase</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="EventDispatcher.html#method__dispatchEvent">EventDispatcher</a>:
            
        
        
        <a href="../files/createjs_events_EventDispatcher.js.html#l380"><code>_dispatchEvent:380</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">eventObj</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="Event.html" class="crosslink">Event</a></span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">eventPhase</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method__getBounds" class="method item protected">
    <h3 class="name"><code>_getBounds</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>matrix</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>ignoreTransform</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="Rectangle.html" class="crosslink">Rectangle</a></span>
        </span>
    

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    

    <div class="meta">
        
            <p>Inherited from
            <a href="DisplayObject.html#method__getBounds">
                DisplayObject
            </a>
            
            but overwritten in
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l682"><code>_getBounds:682</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">matrix</code>
                        <span class="type"><a href="Matrix2D.html" class="crosslink">Matrix2D</a></span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">ignoreTransform</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                    

                    

                    <div class="param-description">
                        <p>If true, does not apply this object&#39;s transform.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="Rectangle.html" class="crosslink">Rectangle</a></span>:
                    
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method__getNumChildren" class="method item protected">
    <h3 class="name"><code>_getNumChildren</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
        </span>
    

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l96"><code>_getNumChildren:96</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Use the <a href="Container.html#property_numChildren" class="crosslink">numChildren</a> property instead.</p>

    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>:
                    
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method__getObjectsUnderPoint" class="method item protected">
    <h3 class="name"><code>_getObjectsUnderPoint</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>x</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>y</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>arr</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>mouse</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>activeListener</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>currentDepth</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>
        </span>
    

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l597"><code>_getObjectsUnderPoint:597</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">x</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">y</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">arr</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">mouse</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                    

                    

                    <div class="param-description">
                        <p>If true, it will respect mouse interaction properties like mouseEnabled, mouseChildren, and active listeners.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">activeListener</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                    

                    

                    <div class="param-description">
                        <p>If true, there is an active mouse event listener on a parent object.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">currentDepth</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>Indicates the current depth of the search.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>:
                    
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method__getStage" class="method item protected inherited">
    <h3 class="name"><code>_getStage</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type"><a href="Stage.html" class="crosslink">Stage</a></span>
        </span>
    

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#method__getStage">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l677"><code>_getStage:677</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Use the <a href="DisplayObject.html#property_stage" class="crosslink">stage</a> property instead.</p>

    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="Stage.html" class="crosslink">Stage</a></span>:
                    
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method__isMouseOpaque" class="method item protected inherited">
    <h3 class="name"><code>_isMouseOpaque</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>
    

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#method__isMouseOpaque">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l1364"><code>_isMouseOpaque:1364</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Indicates whether the display object has any mouse event listeners or a cursor.</p>

    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method__testHit" class="method item protected inherited">
    <h3 class="name"><code>_testHit</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>ctx</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>
    

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#method__testHit">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l1303"><code>_testHit:1303</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">ctx</code>
                        <span class="type">CanvasRenderingContext2D</span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method__testMask" class="method item protected">
    <h3 class="name"><code>_testMask</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>target</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>x</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>y</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>
    

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l651"><code>_testMask:651</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">target</code>
                        <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">x</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">y</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    
                    <p>Indicates whether the x/y is within the masked region.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method__tick" class="method item protected">
    <h3 class="name"><code>_tick</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>evtObj</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    

    <div class="meta">
        
            <p>Inherited from
            <a href="DisplayObject.html#method__tick">
                DisplayObject
            </a>
            
            but overwritten in
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l548"><code>_tick:548</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">evtObj</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                    

                    

                    <div class="param-description">
                        <p>An event object that will be dispatched to all tick listeners. This object is reused between dispatchers to reduce construction &amp; GC costs.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method__transformBounds" class="method item protected inherited">
    <h3 class="name"><code>_transformBounds</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>bounds</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>matrix</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>ignoreTransform</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="Rectangle.html" class="crosslink">Rectangle</a></span>
        </span>
    

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#method__transformBounds">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l1331"><code>_transformBounds:1331</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">bounds</code>
                        <span class="type"><a href="Rectangle.html" class="crosslink">Rectangle</a></span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">matrix</code>
                        <span class="type"><a href="Matrix2D.html" class="crosslink">Matrix2D</a></span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">ignoreTransform</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="Rectangle.html" class="crosslink">Rectangle</a></span>:
                    
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method__updateState" class="method item protected inherited">
    <h3 class="name"><code>_updateState</code></h3>

    
        <span class="paren">()</span>
    

    

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#method__updateState">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l1225"><code>_updateState:1225</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Called before the object gets drawn and is a chance to ensure the display state of the object is correct.
Mostly used by <a href="MovieClip.html" class="crosslink">MovieClip</a> and <a href="BitmapText.html" class="crosslink">BitmapText</a> to
correct their internal state and children prior to being drawn.</p>
<p>Is manually called via draw in a <a href="Stage.html" class="crosslink">Stage</a> but is automatically called when
present in a <a href="StageGL.html" class="crosslink">StageGL</a> instance.</p>

    </div>

    

    

    
</div>

                
                    <div id="method_addChild" class="method item">
    <h3 class="name"><code>addChild</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>child</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l178"><code>addChild:178</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Adds a child to the top of the display list.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code>    container.addChild(bitmapInstance);</code></pre>
<p>You can also add multiple children at once:</p>
<pre class="code prettyprint"><code>    container.addChild(bitmapInstance, shapeInstance, textInstance);</code></pre>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">child</code>
                        <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>
                    

                    

                    <div class="param-description">
                        <p>The display object to add.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>:
                    
                    <p>The child that was added, or the last child if multiple children were added.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_addChildAt" class="method item">
    <h3 class="name"><code>addChildAt</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>child</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>index</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l209"><code>addChildAt:209</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Adds a child to the display list at the specified index, bumping children at equal or greater indexes up one, and
setting its parent to this Container.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code> addChildAt(child1, index);</code></pre>
<p>You can also add multiple children, such as:</p>
<pre class="code prettyprint"><code> addChildAt(child1, child2, ..., index);</code></pre>
<p>The index must be between 0 and numChildren. For example, to add myShape under otherShape in the display list,
you could use:</p>
<pre class="code prettyprint"><code> container.addChildAt(myShape, container.getChildIndex(otherShape));</code></pre>
<p>This would also bump otherShape&#39;s index up by one. Fails silently if the index is out of range.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">child</code>
                        <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>
                    

                    

                    <div class="param-description">
                        <p>The display object to add.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">index</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>The index to add the child at.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>:
                    
                    <p>Returns the last child that was added, or the last child if multiple children were added.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_addEventListener" class="method item inherited">
    <h3 class="name"><code>addEventListener</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>type</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>listener</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[useCapture]</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="EventDispatcher.html#method_addEventListener">EventDispatcher</a>:
            
        
        
        <a href="../files/createjs_events_EventDispatcher.js.html#l140"><code>addEventListener:140</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p><p>Adds the specified event listener. Note that adding multiple listeners to the same function will result in
multiple callbacks getting fired.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code> displayObject.addEventListener("click", handleClick);
 function handleClick(event) {
    // Click happened.
 }</code></pre>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">type</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>The string type of the event.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">listener</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                    

                    

                    <div class="param-description">
                        <p>An object with a handleEvent method, or a function that will be called when
the event is dispatched.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[useCapture]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>For events that bubble, indicates whether to listen for the event in the capture or bubbling/target phase.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
                    
                    <p>Returns the listener for chaining or assignment.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_cache" class="method item inherited">
    <h3 class="name"><code>cache</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>x</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>y</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>width</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>height</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[scale=1]</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[options=undefined]</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#method_cache">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l803"><code>cache:803</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Draws the display object into a new element, which is then used for subsequent draws. Intended for complex content
that does not change frequently (ex. a Container with many children that do not move, or a complex vector Shape),
this can provide for much faster rendering because the content does not need to be re-rendered each tick. The
cached display object can be moved, rotated, faded, etc freely, however if its content changes, you must manually
update the cache by calling <code>updateCache()</code> again. You must specify the cached area via the x, y, w, and h
parameters. This defines the rectangle that will be rendered and cached using this display object&#39;s coordinates.</p>
<p><h4>Example</h4>
For example if you defined a Shape that drew a circle at 0, 0 with a radius of 25:
<pre class="code prettyprint"><code> var shape = new createjs.Shape();
 shape.graphics.beginFill("#ff0000").drawCircle(0, 0, 25);
 shape.cache(-25, -25, 50, 50);</code></pre>
<p>Note that filters need to be defined <em>before</em> the cache is applied or you will have to call updateCache after
application. Check out the <a href="Filter.html" class="crosslink">Filter</a> class for more information. Some filters
(ex. BlurFilter) may not work as expected in conjunction with the scale param.</p>
<p>Usually, the resulting cacheCanvas will have the dimensions width <em> scale, height </em> scale, however some filters (ex. BlurFilter)
will add padding to the canvas dimensions.</p>
<p>In previous versions caching was handled on DisplayObject but has since been moved to <a href="BitmapCache.html" class="crosslink">BitmapCache</a>.
This allows for easier interaction and alternate cache methods like WebGL with <a href="StageGL.html" class="crosslink">StageGL</a>.
For more information on the options object, see the BitmapCache <a href="BitmapCache.html#method_define" class="crosslink">define</a>.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">x</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>The x coordinate origin for the cache region.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">y</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>The y coordinate origin for the cache region.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">width</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>The width of the cache region.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">height</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>The height of the cache region.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[scale=1]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>The scale at which the cache will be created. For example, if you cache a vector shape using
    myShape.cache(0,0,100,100,2) then the resulting cacheCanvas will be 200x200 px. This lets you scale and rotate
    cached elements with greater fidelity. Default is 1.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[options=undefined]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>Specify additional parameters for the cache logic</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method_clone" class="method item">
    <h3 class="name"><code>clone</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code class="optional">[recursive=false]</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="Container.html" class="crosslink">Container</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            <p>Inherited from
            <a href="DisplayObject.html#method_clone">
                DisplayObject
            </a>
            
            but overwritten in
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l523"><code>clone:523</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Returns a clone of this Container. Some properties that are specific to this instance&#39;s current context are
reverted to their defaults (for example .parent).</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name optional">[recursive=false]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>If true, all of the descendants of this container will be cloned recursively. If false, the
properties of the container will be cloned, but the new instance will not have any children.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="Container.html" class="crosslink">Container</a></span>:
                    
                    <p>A clone of the current Container instance.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_cloneChildren" class="method item protected">
    <h3 class="name"><code>cloneChildren</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>o</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l563"><code>cloneChildren:563</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Recursively clones all children of this container, and adds them to the target container.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">o</code>
                        <span class="type"><a href="Container.html" class="crosslink">Container</a></span>
                    

                    

                    <div class="param-description">
                        <p>The target container.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method_contains" class="method item">
    <h3 class="name"><code>contains</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>child</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l435"><code>contains:435</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Returns true if the specified display object either is this container or is a descendent (child, grandchild, etc)
of this container.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">child</code>
                        <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>
                    

                    

                    <div class="param-description">
                        <p>The DisplayObject to be checked.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    
                    <p>true if the specified display object either is this container or is a descendent.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_dispatchEvent" class="method item inherited">
    <h3 class="name"><code>dispatchEvent</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>eventObj</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[bubbles]</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[cancelable]</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="EventDispatcher.html#method_dispatchEvent">EventDispatcher</a>:
            
        
        
        <a href="../files/createjs_events_EventDispatcher.js.html#l285"><code>dispatchEvent:285</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p><p>Dispatches the specified event to all listeners.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code> // Use a string event
 this.dispatchEvent("complete");

 // Use an Event instance
 var event = new createjs.Event("progress");
 this.dispatchEvent(event);</code></pre>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">eventObj</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="Event.html" class="crosslink">Event</a></span>
                    

                    

                    <div class="param-description">
                        <p>An object with a "type" property, or a string type.
While a generic object will work, it is recommended to use a CreateJS Event instance. If a string is used,
dispatchEvent will construct an Event instance if necessary with the specified type. This latter approach can
be used to avoid event object instantiation for non-bubbling events that may not have any listeners.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[bubbles]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>Specifies the <code>bubbles</code> value when a string was passed to eventObj.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[cancelable]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>Specifies the <code>cancelable</code> value when a string was passed to eventObj.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    
                    <p>Returns false if <code>preventDefault()</code> was called on a cancelable event, true otherwise.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_draw" class="method item">
    <h3 class="name"><code>draw</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>ctx</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[ignoreCache=false]</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            <p>Inherited from
            <a href="DisplayObject.html#method_draw">
                DisplayObject
            </a>
            
            but overwritten in
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l149"><code>draw:149</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Draws the display object into the specified context ignoring its visible, alpha, shadow, and transform.
Returns true if the draw was handled (useful for overriding functionality).</p>
<p>NOTE: This method is mainly for internal use, though it may be useful for advanced uses.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">ctx</code>
                        <span class="type">CanvasRenderingContext2D</span>
                    

                    

                    <div class="param-description">
                        <p>The canvas 2D context object to draw into.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[ignoreCache=false]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>Indicates whether the draw operation should ignore any current cache.
For example, used for drawing the cache (to prevent it from simply drawing an existing cache back
into itself).</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method_getBounds" class="method item inherited">
    <h3 class="name"><code>getBounds</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type"><a href="Rectangle.html" class="crosslink">Rectangle</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#method_getBounds">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l1100"><code>getBounds:1100</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Returns a rectangle representing this object&#39;s bounds in its local coordinate system (ie. with no transformation).
Objects that have been cached will return the bounds of the cache.</p>
<p>Not all display objects can calculate their own bounds (ex. Shape). For these objects, you can use 
<a href="DisplayObject.html#method_setBounds" class="crosslink">setBounds</a> so that they are included when calculating Container
bounds.</p>
<table>
    <tr><td><b>All</b></td><td>
        All display objects support setting bounds manually using setBounds(). Likewise, display objects that
        have been cached using cache() will return the bounds of their cache. Manual and cache bounds will override
        the automatic calculations listed below.
    </td></tr>
    <tr><td><b>Bitmap</b></td><td>
        Returns the width and height of the Bitmap/sourceRect (if specified) or image,
        extending from (x=0,y=0).
    </td></tr>
    <tr><td><b>Sprite</b></td><td>
        Returns the bounds of the current frame. May have non-zero x/y if a frame registration point was specified
        in the spritesheet data. See also <a href="SpriteSheet.html#method_getFrameBounds" class="crosslink">getFrameBounds</a>
    </td></tr>
    <tr><td><b>Container</b></td><td>
        Returns the aggregate (combined) bounds of all children that return a non-null value from <code>getBounds()</code>.
    </td></tr>
    <tr><td><b>Shape</b></td><td>
        Does not currently support automatic bounds calculations. Use <code>setBounds()</code> to manually define bounds.
    </td></tr>
    <tr><td><b>Text</b></td><td>
        Returns approximate bounds. Horizontal values (x/width) are quite accurate, but vertical values (y/height)
        are not, especially when using <a href="Text.html#property_textBaseline" class="crosslink">textBaseline</a> values other than "top".
    </td></tr>
    <tr><td><b>BitmapText</b></td><td>
        Returns approximate bounds. Values will be more accurate if spritesheet frame registration points are close
        to (x=0,y=0).
    </td></tr>
</table>

<p>Bounds can be expensive to calculate for some objects (ex. text, or containers with many children), and
are recalculated each time you call getBounds(). You can prevent recalculation on static objects by setting the
bounds explicitly:</p>
<pre class="code prettyprint"><code>var bounds = obj.getBounds();
obj.setBounds(bounds.x, bounds.y, bounds.width, bounds.height);
// getBounds will now use the set values, instead of recalculating</code></pre>
<p>To reduce memory impact, the returned Rectangle instance may be reused internally; clone the instance or copy its
values if you need to retain it.</p>
<pre class="code prettyprint"><code>var myBounds = obj.getBounds().clone();
// OR:
myRect.copy(obj.getBounds());</code></pre>

    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="Rectangle.html" class="crosslink">Rectangle</a></span>:
                    
                    <p>A Rectangle instance representing the bounds, or null if bounds are not available for this
object.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getCacheDataURL" class="method item inherited">
    <h3 class="name"><code>getCacheDataURL</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#method_getCacheDataURL">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l886"><code>getCacheDataURL:886</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Returns a data URL for the cache, or null if this display object is not cached.
Only generated if the cache has changed, otherwise returns last result.</p>

    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
                    
                    <p>The image data url for the cache.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getChildAt" class="method item">
    <h3 class="name"><code>getChildAt</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>index</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l319"><code>getChildAt:319</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Returns the child at the specified index.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code> container.getChildAt(2);</code></pre>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">index</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>The index of the child to return.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>:
                    
                    <p>The child at the specified index. Returns null if there is no child at the index.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getChildByName" class="method item">
    <h3 class="name"><code>getChildByName</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>name</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l334"><code>getChildByName:334</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Returns the child with the specified name.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">name</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>The name of the child to return.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>:
                    
                    <p>The child with the specified name.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getChildIndex" class="method item">
    <h3 class="name"><code>getChildIndex</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>child</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l368"><code>getChildIndex:368</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Returns the index of the specified child in the display list, or -1 if it is not in the display list.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code> var index = container.getChildIndex(child);</code></pre>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">child</code>
                        <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>
                    

                    

                    <div class="param-description">
                        <p>The child to return the index of.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>:
                    
                    <p>The index of the specified child. -1 if the child is not found.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getConcatenatedDisplayProps" class="method item inherited">
    <h3 class="name"><code>getConcatenatedDisplayProps</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code class="optional">[props]</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="DisplayProps.html" class="crosslink">DisplayProps</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#method_getConcatenatedDisplayProps">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l1032"><code>getConcatenatedDisplayProps:1032</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Generates a DisplayProps object representing the combined display properties of the  object and all of its
parent Containers up to the highest level ancestor (usually the <a href="Stage.html" class="crosslink">Stage</a>).</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name optional">[props]</code>
                        <span class="type"><a href="DisplayProps.html" class="crosslink">DisplayProps</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>A <a href="DisplayProps.html" class="crosslink">DisplayProps</a> object to populate with the calculated values.
If null, a new DisplayProps object is returned.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="DisplayProps.html" class="crosslink">DisplayProps</a></span>:
                    
                    <p>The combined display properties.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getConcatenatedMatrix" class="method item inherited">
    <h3 class="name"><code>getConcatenatedMatrix</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code class="optional">[matrix]</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="Matrix2D.html" class="crosslink">Matrix2D</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#method_getConcatenatedMatrix">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l1014"><code>getConcatenatedMatrix:1014</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Generates a Matrix2D object representing the combined transform of the display object and all of its
parent Containers up to the highest level ancestor (usually the <a href="Stage.html" class="crosslink">Stage</a>). This can
be used to transform positions between coordinate spaces, such as with <a href="DisplayObject.html#method_localToGlobal" class="crosslink">localToGlobal</a>
and <a href="DisplayObject.html#method_globalToLocal" class="crosslink">globalToLocal</a>.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name optional">[matrix]</code>
                        <span class="type"><a href="Matrix2D.html" class="crosslink">Matrix2D</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>A <a href="Matrix2D.html" class="crosslink">Matrix2D</a> object to populate with the calculated values.
If null, a new Matrix2D object is returned.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="Matrix2D.html" class="crosslink">Matrix2D</a></span>:
                    
                    <p>The combined matrix.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getMatrix" class="method item inherited">
    <h3 class="name"><code>getMatrix</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>matrix</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="Matrix2D.html" class="crosslink">Matrix2D</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#method_getMatrix">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l1002"><code>getMatrix:1002</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Returns a matrix based on this object&#39;s current transform.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">matrix</code>
                        <span class="type"><a href="Matrix2D.html" class="crosslink">Matrix2D</a></span>
                    

                    

                    <div class="param-description">
                        <p>Optional. A Matrix2D object to populate with the calculated values. If null, a new
Matrix object is returned.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="Matrix2D.html" class="crosslink">Matrix2D</a></span>:
                    
                    <p>A matrix representing this display object&#39;s transform.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getNumChildren" class="method item deprecated">
    <h3 class="name"><code>getNumChildren</code></h3>

    
        <span class="paren">()</span>
    

    

    
        <span class="flag deprecated">deprecated</span>
    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l106"><code>getNumChildren:106</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Use the <a href="Container.html#property_numChildren" class="crosslink">numChildren</a> property instead.</p>

    </div>

    

    

    
</div>

                
                    <div id="method_getObjectsUnderPoint" class="method item">
    <h3 class="name"><code>getObjectsUnderPoint</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>x</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>y</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[mode=0]</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l465"><code>getObjectsUnderPoint:465</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Returns an array of all display objects under the specified coordinates that are in this container&#39;s display
list. This routine ignores any display objects with <a href="DisplayObject.html#property_mouseEnabled" class="crosslink">mouseEnabled</a>
set to <code>false</code>. The array will be sorted in order of visual depth, with the top-most display object at index 0.
This uses shape based hit detection, and can be an expensive operation to run, so it is best to use it carefully.
For example, if testing for objects under the mouse, test on tick (instead of on <a href="Stage.html#event_stagemousemove" class="crosslink">stagemousemove</a>),
and only if the mouse&#39;s position has changed.</p>
<ul>
    <li>By default (mode=0) this method evaluates all display objects.</li>
    <li>By setting the <code>mode</code> parameter to <code>1</code>, the <a href="DisplayObject.html#property_mouseEnabled" class="crosslink">mouseEnabled</a>
        and MouseChildren:property properties will be respected.</li>
       <li>Setting the <code>mode</code> to <code>2</code> additionally excludes display objects that do not have active mouse event
           listeners or a DisplayObject:cursor:property property. That is, only objects
           that would normally intercept mouse interaction will be included. This can significantly improve performance
           in some cases by reducing the number of display objects that need to be tested.</li>
</ul>

<p>This method accounts for both <a href="DisplayObject.html#property_hitArea" class="crosslink">hitArea</a> and <a href="DisplayObject.html#property_mask" class="crosslink">mask</a>.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">x</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>The x position in the container to test.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">y</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>The y position in the container to test.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[mode=0]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>The mode to use to determine which display objects to include. 0-all, 1-respect mouseEnabled/mouseChildren, 2-only mouse opaque objects.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>:
                    
                    <p>An Array of DisplayObjects under the specified coordinates.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getObjectUnderPoint" class="method item">
    <h3 class="name"><code>getObjectUnderPoint</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>x</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>y</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>mode</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l497"><code>getObjectUnderPoint:497</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Similar to <a href="Container.html#method_getObjectsUnderPoint" class="crosslink">getObjectsUnderPoint</a>, but returns only the top-most display
object. This runs significantly faster than <code>getObjectsUnderPoint()</code>, but is still potentially an expensive
operation. See <a href="Container.html#method_getObjectsUnderPoint" class="crosslink">getObjectsUnderPoint</a> for more information.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">x</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>The x position in the container to test.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">y</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>The y position in the container to test.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">mode</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>The mode to use to determine which display objects to include.  0-all, 1-respect mouseEnabled/mouseChildren, 2-only mouse opaque objects.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>:
                    
                    <p>The top-most display object under the specified coordinates.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getStage" class="method item deprecated inherited">
    <h3 class="name"><code>getStage</code></h3>

    
        <span class="paren">()</span>
    

    

    
        <span class="flag deprecated">deprecated</span>
    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#method_getStage">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l691"><code>getStage:691</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Use the <a href="DisplayObject.html#property_stage" class="crosslink">stage</a> property instead.</p>

    </div>

    

    

    
</div>

                
                    <div id="method_getTransformedBounds" class="method item inherited">
    <h3 class="name"><code>getTransformedBounds</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type"><a href="Rectangle.html" class="crosslink">Rectangle</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#method_getTransformedBounds">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l1166"><code>getTransformedBounds:1166</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Returns a rectangle representing this object&#39;s bounds in its parent&#39;s coordinate system (ie. with transformations applied).
Objects that have been cached will return the transformed bounds of the cache.</p>
<p>Not all display objects can calculate their own bounds (ex. Shape). For these objects, you can use 
<a href="DisplayObject.html#method_setBounds" class="crosslink">setBounds</a> so that they are included when calculating Container
bounds.</p>
<p>To reduce memory impact, the returned Rectangle instance may be reused internally; clone the instance or copy its
values if you need to retain it.</p>
<p>Container instances calculate aggregate bounds for all children that return bounds via getBounds.</p>

    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="Rectangle.html" class="crosslink">Rectangle</a></span>:
                    
                    <p>A Rectangle instance representing the bounds, or null if bounds are not available for this object.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_globalToLocal" class="method item inherited">
    <h3 class="name"><code>globalToLocal</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>x</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>y</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[pt]</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="Point.html" class="crosslink">Point</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#method_globalToLocal">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l921"><code>globalToLocal:921</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Transforms the specified x and y position from the global (stage) coordinate space to the
coordinate space of the display object. For example, this could be used to determine
the current mouse position within the display object. Returns a Point instance with x and y properties
correlating to the transformed position in the display object&#39;s coordinate space.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code> displayObject.x = 300;
 displayObject.y = 200;
 stage.addChild(displayObject);
 var point = displayObject.globalToLocal(100, 100);
 // Results in x=-200, y=-100</code></pre>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">x</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>The x position on the stage to transform.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">y</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>The y position on the stage to transform.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[pt]</code>
                        <span class="type"><a href="Point.html" class="crosslink">Point</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>An object to copy the result into. If omitted a new Point object with x/y properties will be returned.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="Point.html" class="crosslink">Point</a></span>:
                    
                    <p>A Point instance with x and y properties correlating to the transformed position in the
display object&#39;s coordinate space.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_hasEventListener" class="method item inherited">
    <h3 class="name"><code>hasEventListener</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>type</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="EventDispatcher.html#method_hasEventListener">EventDispatcher</a>:
            
        
        
        <a href="../files/createjs_events_EventDispatcher.js.html#l339"><code>hasEventListener:339</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Indicates whether there is at least one listener for the specified event type.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">type</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>The string type of the event.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    
                    <p>Returns true if there is at least one listener for the specified event.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_hitTest" class="method item">
    <h3 class="name"><code>hitTest</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>x</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>y</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            <p>Inherited from
            <a href="DisplayObject.html#method_hitTest">
                DisplayObject
            </a>
            
            but overwritten in
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l450"><code>hitTest:450</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Tests whether the display object intersects the specified local point (ie. draws a pixel with alpha &gt; 0 at the
specified position). This ignores the alpha, shadow and compositeOperation of the display object, and all
transform properties including regX/Y.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">x</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>The x position to check in the display object&#39;s local coordinates.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">y</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>The y position to check in the display object&#39;s local coordinates.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    
                    <p>A Boolean indicating whether there is a visible section of a DisplayObject that overlaps the specified
coordinates.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_initialize" class="method item deprecated">
    <h3 class="name"><code>initialize</code></h3>

    
        <span class="paren">()</span>
    

    

    
        <span class="flag deprecated" title="in favour of &#x60;createjs.promote()&#x60;">deprecated</span>
    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l128"><code>initialize:128</code></a>
        
        </p>


        
            <p>Deprecated: in favour of &#x60;createjs.promote()&#x60;</p>
        

        
    </div>

    <div class="description">
        <p>Constructor alias for backwards compatibility. This method will be removed in future versions.
Subclasses should be updated to use Utility Methods/extends.</p>

    </div>

    

    

    
</div>

                
                    <div id="method_isVisible" class="method item">
    <h3 class="name"><code>isVisible</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            <p>Inherited from
            <a href="DisplayObject.html#method_isVisible">
                DisplayObject
            </a>
            
            but overwritten in
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l136"><code>isVisible:136</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Returns true or false indicating whether the display object would be visible if drawn to a canvas.
This does not account for whether it would be visible within the boundaries of the stage.</p>
<p>NOTE: This method is mainly for internal use, though it may be useful for advanced uses.</p>

    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    
                    <p>Boolean indicating whether the display object would be visible if drawn to a canvas</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_localToGlobal" class="method item inherited">
    <h3 class="name"><code>localToGlobal</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>x</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>y</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[pt]</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="Point.html" class="crosslink">Point</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#method_localToGlobal">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l896"><code>localToGlobal:896</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Transforms the specified x and y position from the coordinate space of the display object
to the global (stage) coordinate space. For example, this could be used to position an HTML label
over a specific point on a nested display object. Returns a Point instance with x and y properties
correlating to the transformed coordinates on the stage.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code> displayObject.x = 300;
 displayObject.y = 200;
 stage.addChild(displayObject);
 var point = displayObject.localToGlobal(100, 100);
 // Results in x=400, y=300</code></pre>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">x</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>The x position in the source display object to transform.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">y</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>The y position in the source display object to transform.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[pt]</code>
                        <span class="type"><a href="Point.html" class="crosslink">Point</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>An object to copy the result into. If omitted a new Point object with x/y properties will be returned.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="Point.html" class="crosslink">Point</a></span>:
                    
                    <p>A Point instance with x and y properties correlating to the transformed coordinates
on the stage.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_localToLocal" class="method item inherited">
    <h3 class="name"><code>localToLocal</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>x</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>y</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>target</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[pt]</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="Point.html" class="crosslink">Point</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#method_localToLocal">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l946"><code>localToLocal:946</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Transforms the specified x and y position from the coordinate space of this display object to the coordinate
space of the target display object. Returns a Point instance with x and y properties correlating to the
transformed position in the target&#39;s coordinate space. Effectively the same as using the following code with
<a href="DisplayObject.html#method_localToGlobal" class="crosslink">localToGlobal</a> and <a href="DisplayObject.html#method_globalToLocal" class="crosslink">globalToLocal</a>.</p>
<pre class="code prettyprint"><code> var pt = this.localToGlobal(x, y);
 pt = target.globalToLocal(pt.x, pt.y);</code></pre>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">x</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>The x position in the source display object to transform.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">y</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>The y position on the source display object to transform.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">target</code>
                        <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>
                    

                    

                    <div class="param-description">
                        <p>The target display object to which the coordinates will be transformed.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[pt]</code>
                        <span class="type"><a href="Point.html" class="crosslink">Point</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>An object to copy the result into. If omitted a new Point object with x/y properties will be returned.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="Point.html" class="crosslink">Point</a></span>:
                    
                    <p>Returns a Point instance with x and y properties correlating to the transformed position
in the target&#39;s coordinate space.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_off" class="method item inherited">
    <h3 class="name"><code>off</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>type</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>listener</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[useCapture]</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="EventDispatcher.html#method_off">EventDispatcher</a>:
            
        
        
        <a href="../files/createjs_events_EventDispatcher.js.html#l249"><code>off:249</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>A shortcut to the removeEventListener method, with the same parameters and return value. This is a companion to the
.on method.</p>
<p><b>IMPORTANT:</b> To remove a listener added with <code>on</code>, you must pass in the returned wrapper function as the listener. See 
<a href="EventDispatcher.html#method_on" class="crosslink">on</a> for an example.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">type</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>The string type of the event.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">listener</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                    

                    

                    <div class="param-description">
                        <p>The listener function or object.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[useCapture]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>For events that bubble, indicates whether to listen for the event in the capture or bubbling/target phase.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method_on" class="method item inherited">
    <h3 class="name"><code>on</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>type</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>listener</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[scope]</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[once=false]</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[data]</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[useCapture=false]</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="EventDispatcher.html#method_on">EventDispatcher</a>:
            
        
        
        <a href="../files/createjs_events_EventDispatcher.js.html#l173"><code>on:173</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p><p>A shortcut method for using addEventListener that makes it easier to specify an execution scope, have a listener
only run once, associate arbitrary data with the listener, and remove the listener.</p>
<p><p>This method works by creating an anonymous wrapper function and subscribing it with addEventListener.
The wrapper function is returned for use with <code>removeEventListener</code> (or <code>off</code>).</p>
<p><p><b>IMPORTANT:</b> To remove a listener added with <code>on</code>, you must pass in the returned wrapper function as the listener, or use
<a href="Event.html#method_remove" class="crosslink">remove</a>. Likewise, each time you call <code>on</code> a NEW wrapper function is subscribed, so multiple calls
to <code>on</code> with the same params will create multiple listeners.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code>    var listener = myBtn.on("click", handleClick, null, false, {count:3});
    function handleClick(evt, data) {
        data.count -= 1;
        console.log(this == myBtn); // true - scope defaults to the dispatcher
        if (data.count == 0) {
            alert("clicked 3 times!");
            myBtn.off("click", listener);
            // alternately: evt.remove();
        }
    }</code></pre>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">type</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>The string type of the event.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">listener</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                    

                    

                    <div class="param-description">
                        <p>An object with a handleEvent method, or a function that will be called when
the event is dispatched.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[scope]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>The scope to execute the listener in. Defaults to the dispatcher/currentTarget for function listeners, and to the listener itself for object listeners (ie. using handleEvent).</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[once=false]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>If true, the listener will remove itself after the first time it is triggered.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[data]</code>
                        <span class="type"></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>Arbitrary data that will be included as the second parameter when the listener is called.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[useCapture=false]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>For events that bubble, indicates whether to listen for the event in the capture or bubbling/target phase.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>:
                    
                    <p>Returns the anonymous function that was created and assigned as the listener. This is needed to remove the listener later using .removeEventListener.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_removeAllChildren" class="method item">
    <h3 class="name"><code>removeAllChildren</code></h3>

    
        <span class="paren">()</span>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l305"><code>removeAllChildren:305</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Removes all children from the display list.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code>container.removeAllChildren();</code></pre>

    </div>

    

    

    
</div>

                
                    <div id="method_removeAllEventListeners" class="method item inherited">
    <h3 class="name"><code>removeAllEventListeners</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code class="optional">[type]</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="EventDispatcher.html#method_removeAllEventListeners">EventDispatcher</a>:
            
        
        
        <a href="../files/createjs_events_EventDispatcher.js.html#l263"><code>removeAllEventListeners:263</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p><p>Removes all listeners for the specified type, or all listeners of all types.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code> // Remove all listeners
 displayObject.removeAllEventListeners();

 // Remove all click listeners
 displayObject.removeAllEventListeners("click");</code></pre>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name optional">[type]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>The string type of the event. If omitted, all listeners for all types will be removed.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method_removeChild" class="method item">
    <h3 class="name"><code>removeChild</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>child</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l249"><code>removeChild:249</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Removes the specified child from the display list. Note that it is faster to use removeChildAt() if the index is
already known.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code> container.removeChild(child);</code></pre>
<p>You can also remove multiple children:</p>
<pre class="code prettyprint"><code> removeChild(child1, child2, ...);</code></pre>
<p>Returns true if the child (or children) was removed, or false if it was not in the display list.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">child</code>
                        <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>
                    

                    

                    <div class="param-description">
                        <p>The child to remove.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    
                    <p>true if the child (or children) was removed, or false if it was not in the display list.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_removeChildAt" class="method item protected">
    <h3 class="name"><code>removeChildAt</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>index</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[silent]</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>
    

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l579"><code>removeChildAt:579</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Removes the child at the specified index from the display list, and sets its parent to null.
Used by <code>removeChildAt</code>, <code>addChild</code>, and <code>addChildAt</code>.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">index</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>The index of the child to remove.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[silent]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>Prevents dispatch of <code>removed</code> event if true.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    
                    <p>true if the child (or children) was removed, or false if any index was out of range.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_removeChildAt" class="method item">
    <h3 class="name"><code>removeChildAt</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>index</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l276"><code>removeChildAt:276</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Removes the child at the specified index from the display list, and sets its parent to null.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code> container.removeChildAt(2);</code></pre>
<p>You can also remove multiple children:</p>
<pre class="code prettyprint"><code> container.removeChild(2, 7, ...)</code></pre>
<p>Returns true if the child (or children) was removed, or false if any index was out of range.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">index</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>The index of the child to remove.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    
                    <p>true if the child (or children) was removed, or false if any index was out of range.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_removeEventListener" class="method item inherited">
    <h3 class="name"><code>removeEventListener</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>type</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>listener</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[useCapture]</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="EventDispatcher.html#method_removeEventListener">EventDispatcher</a>:
            
        
        
        <a href="../files/createjs_events_EventDispatcher.js.html#l219"><code>removeEventListener:219</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p><p>Removes the specified event listener.</p>
<p><p><b>Important Note:</b> that you must pass the exact function reference used when the event was added. If a proxy
function, or function closure is used as the callback, the proxy/closure reference must be used - a new proxy or
closure will not work.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code> displayObject.removeEventListener("click", handleClick);</code></pre>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">type</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>The string type of the event.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">listener</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                    

                    

                    <div class="param-description">
                        <p>The listener function or object.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[useCapture]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>For events that bubble, indicates whether to listen for the event in the capture or bubbling/target phase.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method_set" class="method item inherited">
    <h3 class="name"><code>set</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>props</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>
        </span>
    

    

    

    

    

    
        <span class="flag chainable">chainable</span>
    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#method_set">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l1082"><code>set:1082</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Provides a chainable shortcut method for setting a number of properties on the instance.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code> var myGraphics = new createjs.Graphics().beginFill("#ff0000").drawCircle(0, 0, 25);
 var shape = stage.addChild(new Shape()).set({graphics:myGraphics, x:100, y:100, alpha:0.5});</code></pre>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">props</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                    

                    

                    <div class="param-description">
                        <p>A generic object containing properties to copy to the DisplayObject instance.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>:
                    
                    <p>Returns the instance the method is called on (useful for chaining calls.)</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_setBounds" class="method item inherited">
    <h3 class="name"><code>setBounds</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>x</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>y</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>width</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>height</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#method_setBounds">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l1185"><code>setBounds:1185</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Allows you to manually specify the bounds of an object that either cannot calculate their own bounds (ex. Shape &amp;
Text) for future reference, or so the object can be included in Container bounds. Manually set bounds will always
override calculated bounds.</p>
<p>The bounds should be specified in the object&#39;s local (untransformed) coordinates. For example, a Shape instance
with a 25px radius circle centered at 0,0 would have bounds of (-25, -25, 50, 50).</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">x</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>The x origin of the bounds. Pass null to remove the manual bounds.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">y</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>The y origin of the bounds.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">width</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>The width of the bounds.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">height</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>The height of the bounds.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method_setChildIndex" class="method item">
    <h3 class="name"><code>setChildIndex</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>child</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>index</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l418"><code>setChildIndex:418</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Changes the depth of the specified child. Fails silently if the child is not a child of this container, or the index is out of range.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">child</code>
                        <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">index</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method_setTransform" class="method item inherited">
    <h3 class="name"><code>setTransform</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code class="optional">[x=0]</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[y=0]</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[scaleX=1]</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[scaleY=1]</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[rotation=0]</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[skewX=0]</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[skewY=0]</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[regX=0]</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code class="optional">[regY=0]</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>
        </span>
    

    

    

    

    

    
        <span class="flag chainable">chainable</span>
    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#method_setTransform">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l968"><code>setTransform:968</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Shortcut method to quickly set the transform properties on the display object. All parameters are optional.
Omitted parameters will have the default value set.</p>
<h4>Example</h4>

<pre class="code prettyprint"><code> displayObject.setTransform(100, 100, 2, 2);</code></pre>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name optional">[x=0]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>The horizontal translation (x position) in pixels</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[y=0]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>The vertical translation (y position) in pixels</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[scaleX=1]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>The horizontal scale, as a percentage of 1</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[scaleY=1]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>the vertical scale, as a percentage of 1</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[rotation=0]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>The rotation, in degrees</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[skewX=0]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>The horizontal skew factor</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[skewY=0]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>The vertical skew factor</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[regX=0]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>The horizontal registration point in pixels</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name optional">[regY=0]</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>
                    

                    

                    <div class="param-description">
                        <p>The vertical registration point in pixels</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>:
                    
                    <p>Returns this instance. Useful for chaining commands.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_sortChildren" class="method item">
    <h3 class="name"><code>sortChildren</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>sortFunction</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l348"><code>sortChildren:348</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Performs an array sort operation on the child list.</p>
<h4>Example: Display children with a higher y in front.</h4>

<pre class="code prettyprint"><code> var sortFunction = function(obj1, obj2, options) {
     if (obj1.y &gt; obj2.y) { return 1; }
     if (obj1.y &lt; obj2.y) { return -1; }
     return 0;
 }
 container.sortChildren(sortFunction);</code></pre>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">sortFunction</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
                    

                    

                    <div class="param-description">
                        <p>the function to use to sort the child list. See JavaScript&#39;s <code>Array.sort</code>
documentation for details.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method_swapChildren" class="method item">
    <h3 class="name"><code>swapChildren</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>child1</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>child2</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l398"><code>swapChildren:398</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Swaps the specified children&#39;s depth in the display list. Fails silently if either child is not a child of this
Container.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">child1</code>
                        <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">child2</code>
                        <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method_swapChildrenAt" class="method item">
    <h3 class="name"><code>swapChildrenAt</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>index1</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>index2</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l383"><code>swapChildrenAt:383</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Swaps the children at the specified indexes. Fails silently if either index is out of range.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">index1</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">index2</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method_toString" class="method item">
    <h3 class="name"><code>toString</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            <p>Inherited from
            <a href="EventDispatcher.html#method_toString">
                EventDispatcher
            </a>
            
            but overwritten in
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l537"><code>toString:537</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Returns a string representation of this object.</p>

    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
                    
                    <p>a string representation of the instance.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_uncache" class="method item inherited">
    <h3 class="name"><code>uncache</code></h3>

    
        <span class="paren">()</span>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#method_uncache">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l875"><code>uncache:875</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Clears the current cache. See <a href="DisplayObject.html#method_cache" class="crosslink">cache</a> for more information.</p>

    </div>

    

    

    
</div>

                
                    <div id="method_updateCache" class="method item inherited">
    <h3 class="name"><code>updateCache</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>compositeOperation</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#method_updateCache">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l846"><code>updateCache:846</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Redraws the display object to its cache. Calling updateCache without an active cache will throw an error.
If compositeOperation is null the current cache will be cleared prior to drawing. Otherwise the display object
will be drawn over the existing cache using the specified compositeOperation.</p>
<p><h4>Example</h4>
Clear the current graphics of a cached shape, draw some new instructions, and then update the cache. The new line
will be drawn on top of the old one.
<pre class="code prettyprint"><code> // Not shown: Creating the shape, and caching it.
 shapeInstance.clear();
 shapeInstance.setStrokeStyle(3).beginStroke("#ff0000").moveTo(100, 100).lineTo(200,200);
 shapeInstance.updateCache();</code></pre>
<p>In previous versions caching was handled on DisplayObject but has since been moved to <a href="BitmapCache.html" class="crosslink">BitmapCache</a>.
This allows for easier interaction and alternate cache methods like WebGL and <a href="StageGL.html" class="crosslink">StageGL</a>.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">compositeOperation</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>The compositeOperation to use, or null to clear the cache and redraw it.
<a href="https://html.spec.whatwg.org/multipage/scripting.html#dom-context-2d-globalcompositeoperation">
whatwg spec on compositing</a>.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method_updateContext" class="method item inherited">
    <h3 class="name"><code>updateContext</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>ctx</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#method_updateContext">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l771"><code>updateContext:771</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Applies this display object&#39;s transformation, alpha, globalCompositeOperation, clipping path (mask), and shadow
to the specified context. This is typically called prior to <a href="DisplayObject.html#method_draw" class="crosslink">draw</a>.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">ctx</code>
                        <span class="type">CanvasRenderingContext2D</span>
                    

                    

                    <div class="param-description">
                        <p>The canvas 2D to update.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method_willTrigger" class="method item inherited">
    <h3 class="name"><code>willTrigger</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>type</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="EventDispatcher.html#method_willTrigger">EventDispatcher</a>:
            
        
        
        <a href="../files/createjs_events_EventDispatcher.js.html#l350"><code>willTrigger:350</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Indicates whether there is at least one listener for the specified event type on this object or any of its
ancestors (parent, parent&#39;s parent, etc). A return value of true indicates that if a bubbling event of the
specified type is dispatched from this object, it will trigger at least one listener.</p>
<p>This is similar to <a href="EventDispatcher.html#method_hasEventListener" class="crosslink">hasEventListener</a>, but it searches the entire
event flow for a listener, not just this object.</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">type</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>The string type of the event.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
                    
                    <p>Returns <code>true</code> if there is at least one listener for the specified event.</p>

                
            </div>
        </div>
    

    
</div>

                
            </div>
        

        
            <div id="properties" class="api-class-tabpanel">
                <h2 class="off-left">Properties</h2>

                
                    <div id="property__bounds" class="property item protected inherited">
    <h3 class="name"><code>_bounds</code></h3>
    <span class="type"><a href="Rectangle.html" class="crosslink">Rectangle</a></span>

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property__bounds">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l446"><code>_bounds:446</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        
    </div>

    
        <p><strong>Default:</strong> null</p>
    

    

    
</div>

                
                    <div id="property__cacheDataURL" class="property item protected deprecated inherited">
    <h3 class="name"><code>_cacheDataURL</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

    
        <span class="flag deprecated">deprecated</span>
    

    
        <span class="flag protected">protected</span>
    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property__cacheDataURL">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l421"><code>_cacheDataURL:421</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Moved to <a href="BitmapCache.html" class="crosslink">BitmapCache</a></p>

    </div>

    
        <p><strong>Default:</strong> null</p>
    

    

    
</div>

                
                    <div id="property__cacheDataURLID" class="property item protected deprecated inherited">
    <h3 class="name"><code>_cacheDataURLID</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

    
        <span class="flag deprecated">deprecated</span>
    

    
        <span class="flag protected">protected</span>
    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property__cacheDataURLID">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l412"><code>_cacheDataURLID:412</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Moved to <a href="BitmapCache.html" class="crosslink">BitmapCache</a></p>

    </div>

    
        <p><strong>Default:</strong> 0</p>
    

    

    
</div>

                
                    <div id="property__cacheScale" class="property item protected deprecated inherited">
    <h3 class="name"><code>_cacheScale</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

    
        <span class="flag deprecated">deprecated</span>
    

    
        <span class="flag protected">protected</span>
    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property__cacheScale">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l403"><code>_cacheScale:403</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Moved to <a href="BitmapCache.html" class="crosslink">BitmapCache</a></p>

    </div>

    
        <p><strong>Default:</strong> 1</p>
    

    

    
</div>

                
                    <div id="property__captureListeners" class="property item protected inherited">
    <h3 class="name"><code>_captureListeners</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="EventDispatcher.html#property__captureListeners">EventDispatcher</a>:
            
        
        
        <a href="../files/createjs_events_EventDispatcher.js.html#l106"><code>_captureListeners:106</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        
    </div>

    

    

    
</div>

                
                    <div id="property__listeners" class="property item protected inherited">
    <h3 class="name"><code>_listeners</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="EventDispatcher.html#property__listeners">EventDispatcher</a>:
            
        
        
        <a href="../files/createjs_events_EventDispatcher.js.html#l99"><code>_listeners:99</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        
    </div>

    

    

    
</div>

                
                    <div id="property__props" class="property item protected inherited">
    <h3 class="name"><code>_props</code></h3>
    <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property__props">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l430"><code>_props:430</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        
    </div>

    
        <p><strong>Default:</strong> null</p>
    

    

    
</div>

                
                    <div id="property__rectangle" class="property item protected inherited">
    <h3 class="name"><code>_rectangle</code></h3>
    <span class="type"><a href="Rectangle.html" class="crosslink">Rectangle</a></span>

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property__rectangle">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l438"><code>_rectangle:438</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        
    </div>

    
        <p><strong>Default:</strong> null</p>
    

    

    
</div>

                
                    <div id="property__webGLRenderStyle" class="property item protected inherited">
    <h3 class="name"><code>_webGLRenderStyle</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

    

    
        <span class="flag protected">protected</span>
    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property__webGLRenderStyle">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l454"><code>_webGLRenderStyle:454</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Where StageGL should look for required display properties, matters only for leaf display objects. Containers
or cached objects won&#39;t use this property, it&#39;s for native display of terminal elements.</p>

    </div>

    
        <p><strong>Default:</strong> 0</p>
    

    

    
</div>

                
                    <div id="property_alpha" class="property item inherited">
    <h3 class="name"><code>alpha</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_alpha">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l147"><code>alpha:147</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>The alpha (transparency) for this display object. 0 is fully transparent, 1 is fully opaque.</p>

    </div>

    
        <p><strong>Default:</strong> 1</p>
    

    

    
</div>

                
                    <div id="property_bitmapCache" class="property item inherited">
    <h3 class="name"><code>bitmapCache</code></h3>
    <span class="type"><a href="BitmapCache.html" class="crosslink">BitmapCache</a></span>

    

    

    

    

    
        <span class="flag readonly">readonly</span>
    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_bitmapCache">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l165"><code>bitmapCache:165</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>If a cache has been made, this returns the class that is managing the cacheCanvas and its properties. See <a href="BitmapCache.html" class="crosslink">BitmapCache</a>
for more information. Use this to control, inspect, and change the cache. In special circumstances this may be a modified or subclassed BitmapCache.</p>

    </div>

    
        <p><strong>Default:</strong> null</p>
    

    

    
</div>

                
                    <div id="property_cacheCanvas" class="property item inherited">
    <h3 class="name"><code>cacheCanvas</code></h3>
    <span class="type">HTMLCanvasElement | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

    

    

    

    

    
        <span class="flag readonly">readonly</span>
    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_cacheCanvas">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l155"><code>cacheCanvas:155</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>If a cache is active, this returns the canvas that holds the image of this display object. See <a href="DisplayObject.html#method_cache" class="crosslink">cache</a>
for more information. Use this to display the result of a cache. This will be a HTMLCanvasElement unless special cache rules have been deliberately enabled for this cache.</p>

    </div>

    
        <p><strong>Default:</strong> null</p>
    

    

    
</div>

                
                    <div id="property_cacheID" class="property item deprecated inherited">
    <h3 class="name"><code>cacheID</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

    
        <span class="flag deprecated">deprecated</span>
    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_cacheID">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l706"><code>cacheID:706</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Returns an ID number that uniquely identifies the current cache for this display object. This can be used to
determine if the cache has changed since a previous check.
Moved to <a href="BitmapCache.html" class="crosslink">BitmapCache</a></p>

    </div>

    
        <p><strong>Default:</strong> 0</p>
    

    

    
</div>

                
                    <div id="property_children" class="property item">
    <h3 class="name"><code>children</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l61"><code>children:61</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>The array of children in the display list. You should usually use the child management methods such as
<a href="Container.html#method_addChild" class="crosslink">addChild</a>, <a href="Container.html#method_removeChild" class="crosslink">removeChild</a>,
<a href="Container.html#method_swapChildren" class="crosslink">swapChildren</a>, etc, rather than accessing this directly, but it is
included for advanced uses.</p>

    </div>

    
        <p><strong>Default:</strong> null</p>
    

    

    
</div>

                
                    <div id="property_compositeOperation" class="property item inherited">
    <h3 class="name"><code>compositeOperation</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_compositeOperation">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l333"><code>compositeOperation:333</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>The composite operation indicates how the pixels of this display object will be composited with the elements
behind it. If <code>null</code>, this property is inherited from the parent container. For more information, read the
<a href="https://html.spec.whatwg.org/multipage/scripting.html#dom-context-2d-globalcompositeoperation">
whatwg spec on compositing</a>. For a list of supported compositeOperation value, visit
<a href="https://drafts.fxtf.org/compositing/">the W3C draft on Compositing and Blending</a>.</p>

    </div>

    
        <p><strong>Default:</strong> null</p>
    

    

    
</div>

                
                    <div id="property_cursor" class="property item inherited">
    <h3 class="name"><code>cursor</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_cursor">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l391"><code>cursor:391</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>A CSS cursor (ex. "pointer", "help", "text", etc) that will be displayed when the user hovers over this display
object. You must enable mouseover events using the <a href="Stage.html#method_enableMouseOver" class="crosslink">enableMouseOver</a> method to
use this property. Setting a non-null cursor on a Container will override the cursor set on its descendants.</p>

    </div>

    
        <p><strong>Default:</strong> null</p>
    

    

    
</div>

                
                    <div id="property_filters" class="property item inherited">
    <h3 class="name"><code>filters</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_filters">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l355"><code>filters:355</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>An array of Filter objects to apply to this display object. Filters are only applied / updated when Cache
or UpdateCache is called on the display object, and only apply to the area that is
cached.</p>

    </div>

    
        <p><strong>Default:</strong> null</p>
    

    

    
</div>

                
                    <div id="property_hitArea" class="property item inherited">
    <h3 class="name"><code>hitArea</code></h3>
    <span class="type"><a href="DisplayObject.html" class="crosslink">DisplayObject</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_hitArea">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l374"><code>hitArea:374</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>A display object that will be tested when checking mouse interactions or testing <a href="Container.html#method_getObjectsUnderPoint" class="crosslink">getObjectsUnderPoint</a>.
The hit area will have its transformation applied relative to this display object&#39;s coordinate space (as though
the hit test object were a child of this display object and relative to its regX/Y). The hitArea will be tested
using only its own <code>alpha</code> value regardless of the alpha value on the target display object, or the target&#39;s
ancestors (parents).</p>
<p>If set on a <a href="Container.html" class="crosslink">Container</a>, children of the Container will not receive mouse events.
This is similar to setting MouseChildren to false.</p>
<p>Note that hitArea is NOT currently used by the <code>hitTest()</code> method, nor is it supported for <a href="Stage.html" class="crosslink">Stage</a>.</p>

    </div>

    
        <p><strong>Default:</strong> null</p>
    

    

    
</div>

                
                    <div id="property_id" class="property item inherited">
    <h3 class="name"><code>id</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_id">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l175"><code>id:175</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Unique ID for this display object. Makes display objects easier for some uses.</p>

    </div>

    
        <p><strong>Default:</strong> -1</p>
    

    

    
</div>

                
                    <div id="property_mask" class="property item inherited">
    <h3 class="name"><code>mask</code></h3>
    <span class="type"><a href="Shape.html" class="crosslink">Shape</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_mask">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l365"><code>mask:365</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>A Shape instance that defines a vector mask (clipping path) for this display object.  The shape&#39;s transformation
will be applied relative to the display object&#39;s parent coordinates (as if it were a child of the parent).</p>

    </div>

    
        <p><strong>Default:</strong> null</p>
    

    

    
</div>

                
                    <div id="property_mouseChildren" class="property item">
    <h3 class="name"><code>mouseChildren</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l72"><code>mouseChildren:72</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Indicates whether the children of this container are independently enabled for mouse/pointer interaction.
If false, the children will be aggregated under the container - for example, a click on a child shape would
trigger a click event on the container.</p>

    </div>

    
        <p><strong>Default:</strong> true</p>
    

    

    
</div>

                
                    <div id="property_mouseEnabled" class="property item inherited">
    <h3 class="name"><code>mouseEnabled</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_mouseEnabled">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l183"><code>mouseEnabled:183</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Indicates whether to include this object when running mouse interactions. Setting this to <code>false</code> for children
of a <a href="Container.html" class="crosslink">Container</a> will cause events on the Container to not fire when that child is
clicked. Setting this property to <code>false</code> does not prevent the <a href="Container.html#method_getObjectsUnderPoint" class="crosslink">getObjectsUnderPoint</a>
method from returning the child.</p>
<p><strong>Note:</strong> In EaselJS 0.7.0, the mouseEnabled property will not work properly with nested Containers. Please
check out the latest NEXT version in <a href="https://github.com/CreateJS/EaselJS/tree/master/lib">GitHub</a> for an updated version with this issue resolved. The fix will be
provided in the next release of EaselJS.</p>

    </div>

    
        <p><strong>Default:</strong> true</p>
    

    

    
</div>

                
                    <div id="property_name" class="property item inherited">
    <h3 class="name"><code>name</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_name">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l208"><code>name:208</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>An optional name for this display object. Included in <a href="DisplayObject.html#method_toString" class="crosslink">toString</a> . Useful for
debugging.</p>

    </div>

    
        <p><strong>Default:</strong> null</p>
    

    

    
</div>

                
                    <div id="property_numChildren" class="property item">
    <h3 class="name"><code>numChildren</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

    

    

    

    

    
        <span class="flag readonly">readonly</span>
    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l114"><code>numChildren:114</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Returns the number of children in the container.</p>

    </div>

    

    

    
</div>

                
                    <div id="property_parent" class="property item inherited">
    <h3 class="name"><code>parent</code></h3>
    <span class="type"><a href="Container.html" class="crosslink">Container</a></span>

    

    

    
        <span class="flag final">final</span>
    

    

    
        <span class="flag readonly">readonly</span>
    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_parent">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l217"><code>parent:217</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>A reference to the <a href="Container.html" class="crosslink">Container</a> or <a href="Stage.html" class="crosslink">Stage</a> object that
contains this display object, or null if it has not been added
to one.</p>

    </div>

    
        <p><strong>Default:</strong> null</p>
    

    

    
</div>

                
                    <div id="property_regX" class="property item inherited">
    <h3 class="name"><code>regX</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_regX">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l229"><code>regX:229</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>The left offset for this display object&#39;s registration point. For example, to make a 100x100px Bitmap rotate
around its center, you would set regX and <a href="DisplayObject.html#property_regY" class="crosslink">regY</a> to 50.
Cached object&#39;s registration points should be set based on pre-cache conditions, not cached size.</p>

    </div>

    
        <p><strong>Default:</strong> 0</p>
    

    

    
</div>

                
                    <div id="property_regY" class="property item inherited">
    <h3 class="name"><code>regY</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_regY">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l239"><code>regY:239</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>The y offset for this display object&#39;s registration point. For example, to make a 100x100px Bitmap rotate around
its center, you would set <a href="DisplayObject.html#property_regX" class="crosslink">regX</a> and regY to 50.
Cached object&#39;s registration points should be set based on pre-cache conditions, not cached size.</p>

    </div>

    
        <p><strong>Default:</strong> 0</p>
    

    

    
</div>

                
                    <div id="property_rotation" class="property item inherited">
    <h3 class="name"><code>rotation</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_rotation">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l249"><code>rotation:249</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>The rotation in degrees for this display object.</p>

    </div>

    
        <p><strong>Default:</strong> 0</p>
    

    

    
</div>

                
                    <div id="property_scale" class="property item inherited">
    <h3 class="name"><code>scale</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_scale">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l716"><code>scale:716</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Set both the <a href="DisplayObject.html#property_scaleX" class="crosslink">scaleX</a> and the <a href="DisplayObject.html#property_scaleY" class="crosslink">scaleY</a>
property to the same value. Note that when you get the value, if the <code>scaleX</code> and <code>scaleY</code> are different values,
it will return only the <code>scaleX</code>.</p>

    </div>

    
        <p><strong>Default:</strong> 1</p>
    

    

    
</div>

                
                    <div id="property_scaleX" class="property item inherited">
    <h3 class="name"><code>scaleX</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_scaleX">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l257"><code>scaleX:257</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>The factor to stretch this display object horizontally. For example, setting scaleX to 2 will stretch the display
object to twice its nominal width. To horizontally flip an object, set the scale to a negative number.</p>

    </div>

    
        <p><strong>Default:</strong> 1</p>
    

    

    
</div>

                
                    <div id="property_scaleY" class="property item inherited">
    <h3 class="name"><code>scaleY</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_scaleY">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l266"><code>scaleY:266</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>The factor to stretch this display object vertically. For example, setting scaleY to 0.5 will stretch the display
object to half its nominal height. To vertically flip an object, set the scale to a negative number.</p>

    </div>

    
        <p><strong>Default:</strong> 1</p>
    

    

    
</div>

                
                    <div id="property_shadow" class="property item inherited">
    <h3 class="name"><code>shadow</code></h3>
    <span class="type"><a href="Shadow.html" class="crosslink">Shadow</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_shadow">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l291"><code>shadow:291</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>A shadow object that defines the shadow to render on this display object. Set to <code>null</code> to remove a shadow. If
null, this property is inherited from the parent container.</p>

    </div>

    
        <p><strong>Default:</strong> null</p>
    

    

    
</div>

                
                    <div id="property_skewX" class="property item inherited">
    <h3 class="name"><code>skewX</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_skewX">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l275"><code>skewX:275</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>The factor to skew this display object horizontally.</p>

    </div>

    
        <p><strong>Default:</strong> 0</p>
    

    

    
</div>

                
                    <div id="property_skewY" class="property item inherited">
    <h3 class="name"><code>skewY</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_skewY">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l283"><code>skewY:283</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>The factor to skew this display object vertically.</p>

    </div>

    
        <p><strong>Default:</strong> 0</p>
    

    

    
</div>

                
                    <div id="property_snapToPixel" class="property item inherited">
    <h3 class="name"><code>snapToPixel</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_snapToPixel">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l345"><code>snapToPixel:345</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Indicates whether the display object should be drawn to a whole pixel when
<a href="Stage.html#property_snapToPixelEnabled" class="crosslink">snapToPixelEnabled</a> is true. To enable/disable snapping on whole
categories of display objects, set this value on the prototype (Ex. Text.prototype.snapToPixel = true).</p>

    </div>

    
        <p><strong>Default:</strong> true</p>
    

    

    
</div>

                
                    <div id="property_stage" class="property item inherited">
    <h3 class="name"><code>stage</code></h3>
    <span class="type"><a href="Stage.html" class="crosslink">Stage</a></span>

    

    

    

    

    
        <span class="flag readonly">readonly</span>
    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_stage">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l699"><code>stage:699</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Returns the Stage instance that this display object will be rendered on, or null if it has not been added to one.</p>

    </div>

    

    

    
</div>

                
                    <div id="property_tickChildren" class="property item">
    <h3 class="name"><code>tickChildren</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/easeljs_display_Container.js.html#l82"><code>tickChildren:82</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>If false, the tick will not be propagated to children of this Container. This can provide some performance benefits.
In addition to preventing the "tick" event from being dispatched, it will also prevent tick related updates
on some display objects (ex. Sprite &amp; MovieClip frame advancing, DOMElement visibility handling).</p>

    </div>

    
        <p><strong>Default:</strong> true</p>
    

    

    
</div>

                
                    <div id="property_tickEnabled" class="property item inherited">
    <h3 class="name"><code>tickEnabled</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_tickEnabled">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l198"><code>tickEnabled:198</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>If false, the tick will not run on this display object (or its children). This can provide some performance benefits.
In addition to preventing the "tick" event from being dispatched, it will also prevent tick related updates
on some display objects (ex. Sprite &amp; MovieClip frame advancing, and DOMElement display properties).</p>

    </div>

    
        <p><strong>Default:</strong> true</p>
    

    

    
</div>

                
                    <div id="property_transformMatrix" class="property item inherited">
    <h3 class="name"><code>transformMatrix</code></h3>
    <span class="type"><a href="Matrix2D.html" class="crosslink">Matrix2D</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_transformMatrix">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l324"><code>transformMatrix:324</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>If set, defines the transformation for this display object, overriding all other transformation properties
(x, y, rotation, scale, skew).</p>

    </div>

    
        <p><strong>Default:</strong> null</p>
    

    

    
</div>

                
                    <div id="property_visible" class="property item inherited">
    <h3 class="name"><code>visible</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_visible">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l300"><code>visible:300</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Indicates whether this display object should be rendered to the canvas and included when running the Stage
<a href="Container.html#method_getObjectsUnderPoint" class="crosslink">getObjectsUnderPoint</a> method.</p>

    </div>

    
        <p><strong>Default:</strong> true</p>
    

    

    
</div>

                
                    <div id="property_x" class="property item inherited">
    <h3 class="name"><code>x</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_x">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l309"><code>x:309</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>The x (horizontal) position of the display object, relative to its parent.</p>

    </div>

    
        <p><strong>Default:</strong> 0</p>
    

    

    
</div>

                
                    <div id="property_y" class="property item inherited">
    <h3 class="name"><code>y</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

    

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#property_y">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l317"><code>y:317</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        
    </div>

    
        <p><strong>Default:</strong> 0</p>
    

    

    
</div>

                
            </div>
        

        

        
            <div id="events" class="api-class-tabpanel">
                <h2 class="off-left">Events</h2>

                
                    <div id="event_added" class="events item inherited">
    <h3 class="name"><code>added</code></h3>
    <span class="type"></span>

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#event_added">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l651"><code>added:651</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Dispatched when the display object is added to a parent container.</p>

    </div>

    


    
</div>

                
                    <div id="event_click" class="events item inherited">
    <h3 class="name"><code>click</code></h3>
    <span class="type"></span>

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#event_click">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l549"><code>click:549</code></a>
        
        </p>

        

        
            <p>Available since 0.6.0</p>
        
    </div>

    <div class="description">
        <p>Dispatched when the user presses their left mouse button and then releases it while over the display object.
See the <a href="MouseEvent.html" class="crosslink">MouseEvent</a> class for a listing of event properties.</p>

    </div>

    


    
</div>

                
                    <div id="event_dblclick" class="events item inherited">
    <h3 class="name"><code>dblclick</code></h3>
    <span class="type"></span>

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#event_dblclick">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l556"><code>dblclick:556</code></a>
        
        </p>

        

        
            <p>Available since 0.6.0</p>
        
    </div>

    <div class="description">
        <p>Dispatched when the user double clicks their left mouse button over this display object.
See the <a href="MouseEvent.html" class="crosslink">MouseEvent</a> class for a listing of event properties.</p>

    </div>

    


    
</div>

                
                    <div id="event_mousedown" class="events item inherited">
    <h3 class="name"><code>mousedown</code></h3>
    <span class="type"></span>

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#event_mousedown">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l542"><code>mousedown:542</code></a>
        
        </p>

        

        
            <p>Available since 0.6.0</p>
        
    </div>

    <div class="description">
        <p>Dispatched when the user presses their left mouse button over the display object. See the 
<a href="MouseEvent.html" class="crosslink">MouseEvent</a> class for a listing of event properties.</p>

    </div>

    


    
</div>

                
                    <div id="event_mouseout" class="events item inherited">
    <h3 class="name"><code>mouseout</code></h3>
    <span class="type"></span>

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#event_mouseout">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l571"><code>mouseout:571</code></a>
        
        </p>

        

        
            <p>Available since 0.6.0</p>
        
    </div>

    <div class="description">
        <p>Dispatched when the user&#39;s mouse leaves this display object. This event must be enabled using 
<a href="Stage.html#method_enableMouseOver" class="crosslink">enableMouseOver</a>. See also <a href="DisplayObject.html#event_rollout" class="crosslink">rollout</a>.
See the <a href="MouseEvent.html" class="crosslink">MouseEvent</a> class for a listing of event properties.</p>

    </div>

    


    
</div>

                
                    <div id="event_mouseover" class="events item inherited">
    <h3 class="name"><code>mouseover</code></h3>
    <span class="type"></span>

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#event_mouseover">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l563"><code>mouseover:563</code></a>
        
        </p>

        

        
            <p>Available since 0.6.0</p>
        
    </div>

    <div class="description">
        <p>Dispatched when the user&#39;s mouse enters this display object. This event must be enabled using 
<a href="Stage.html#method_enableMouseOver" class="crosslink">enableMouseOver</a>. See also <a href="DisplayObject.html#event_rollover" class="crosslink">rollover</a>.
See the <a href="MouseEvent.html" class="crosslink">MouseEvent</a> class for a listing of event properties.</p>

    </div>

    


    
</div>

                
                    <div id="event_pressmove" class="events item inherited">
    <h3 class="name"><code>pressmove</code></h3>
    <span class="type"></span>

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#event_pressmove">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l621"><code>pressmove:621</code></a>
        
        </p>

        

        
            <p>Available since 0.7.0</p>
        
    </div>

    <div class="description">
        <p>After a <a href="DisplayObject.html#event_mousedown" class="crosslink">mousedown</a> occurs on a display object, a pressmove
event will be generated on that object whenever the mouse moves until the mouse press is released. This can be
useful for dragging and similar operations.</p>
<p><strong>Please note</strong> that if the initial mouse target from a <code>mousedown</code> event is removed from the stage after being pressed
(e.g. during a <code>pressmove</code> event), a <code>pressmove</code> event is still generated. However since it is no longer in the
display list, the event can not bubble. This means that previous ancestors (parent containers) will not receive
the event, and therefore can not re-dispatch it. If you intend to listen for <code><a href="DisplayObject.html#event_pressup" class="crosslink">pressup</a></code>
or <code>pressmove</code> on a dynamic object (such as a <a href="MovieClip.html" class="crosslink">MovieClip</a> or <a href="Container.html" class="crosslink">Container</a>),
then ensure you set <a href="Container.html#property_mouseChildren" class="crosslink">mouseChildren</a> to <code>false</code>.</p>

    </div>

    


    
</div>

                
                    <div id="event_pressup" class="events item inherited">
    <h3 class="name"><code>pressup</code></h3>
    <span class="type"></span>

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#event_pressup">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l636"><code>pressup:636</code></a>
        
        </p>

        

        
            <p>Available since 0.7.0</p>
        
    </div>

    <div class="description">
        <p>After a <a href="DisplayObject.html#event_mousedown" class="crosslink">mousedown</a> occurs on a display object, a pressup event
will be generated on that object when that mouse press is released. This can be useful for dragging and similar
operations.</p>
<p><strong>Please note</strong> that if the initial mouse target from a <code>mousedown</code> event is removed from the stage after being pressed
(e.g. during a <code>pressmove</code> event), a <code>pressup</code> event is still generated. However since it is no longer in the
display list, the event can not bubble. This means that previous ancestors (parent containers) will not receive
the event, and therefore can not re-dispatch it. If you intend to listen for <code><a href="DisplayObject.html#event_pressmove" class="crosslink">pressmove</a></code>
or <code>pressup</code> on a dynamic object (such as a <a href="MovieClip.html" class="crosslink">MovieClip</a> or <a href="Container.html" class="crosslink">Container</a>),
then ensure you set <a href="Container.html#property_mouseChildren" class="crosslink">mouseChildren</a> to <code>false</code>.</p>

    </div>

    


    
</div>

                
                    <div id="event_removed" class="events item inherited">
    <h3 class="name"><code>removed</code></h3>
    <span class="type"></span>

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#event_removed">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l656"><code>removed:656</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Dispatched when the display object is removed from its parent container.</p>

    </div>

    


    
</div>

                
                    <div id="event_rollout" class="events item inherited">
    <h3 class="name"><code>rollout</code></h3>
    <span class="type"></span>

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#event_rollout">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l600"><code>rollout:600</code></a>
        
        </p>

        

        
            <p>Available since 0.7.0</p>
        
    </div>

    <div class="description">
        <p>This event is similar to <a href="DisplayObject.html#event_mouseout" class="crosslink">mouseout</a>, with the following
differences: it does not bubble, and it considers <a href="Container.html" class="crosslink">Container</a> instances as an
aggregate of their content.</p>
<p>For example, myContainer contains two overlapping children: shapeA and shapeB. The user moves their mouse over
shapeA, then directly on to shapeB, then off both. With a listener for Mouseout:event
on myContainer, two events would be received, each targeting a child element:</p>
<p><ol>
        <li>when the mouse leaves shapeA (target=shapeA)</li>
        <li>when the mouse leaves shapeB (target=shapeB)</li>
</ol>
However, with a listener for "rollout" instead, only a single event is received when the mouse leaves
the aggregate myContainer content (target=myContainer).
<p>This event must be enabled using <a href="Stage.html#method_enableMouseOver" class="crosslink">enableMouseOver</a>.
See the <a href="MouseEvent.html" class="crosslink">MouseEvent</a> class for a listing of event properties.</p>

    </div>

    


    
</div>

                
                    <div id="event_rollover" class="events item inherited">
    <h3 class="name"><code>rollover</code></h3>
    <span class="type"></span>

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#event_rollover">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l579"><code>rollover:579</code></a>
        
        </p>

        

        
            <p>Available since 0.7.0</p>
        
    </div>

    <div class="description">
        <p>This event is similar to <a href="DisplayObject.html#event_mouseover" class="crosslink">mouseover</a>, with the following
differences: it does not bubble, and it considers <a href="Container.html" class="crosslink">Container</a> instances as an
aggregate of their content.</p>
<p>For example, myContainer contains two overlapping children: shapeA and shapeB. The user moves their mouse over
shapeA and then directly on to shapeB. With a listener for Mouseover:event on
myContainer, two events would be received, each targeting a child element:</p>
<p><ol>
        <li>when the mouse enters shapeA (target=shapeA)</li>
        <li>when the mouse enters shapeB (target=shapeB)</li>
</ol>
However, with a listener for "rollover" instead, only a single event is received when the mouse first enters
the aggregate myContainer content (target=myContainer).
<p>This event must be enabled using <a href="Stage.html#method_enableMouseOver" class="crosslink">enableMouseOver</a>.
See the <a href="MouseEvent.html" class="crosslink">MouseEvent</a> class for a listing of event properties.</p>

    </div>

    


    
</div>

                
                    <div id="event_tick" class="events item inherited">
    <h3 class="name"><code>tick</code></h3>
    <span class="type"></span>

    

    

    

    

    <div class="meta">
        
            
                <p>Inherited from
                <a href="DisplayObject.html#event_tick">DisplayObject</a>:
            
        
        
        <a href="../files/easeljs_display_DisplayObject.js.html#l661"><code>tick:661</code></a>
        
        </p>

        

        
            <p>Available since 0.6.0</p>
        
    </div>

    <div class="description">
        <p>Dispatched on each display object on a stage whenever the stage updates. This occurs immediately before the
rendering (draw) pass. When <a href="Stage.html#method_update" class="crosslink">update</a> is called, first all display objects on
the stage dispatch the tick event, then all of the display objects are drawn to stage. Children will have their
Tick:event event dispatched in order of their depth prior to the event being
dispatched on their parent.</p>

    </div>

    
        <div class="params">
            <h4>Event Payload:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">target</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
                    

                    

                    <div class="param-description">
                        <p>The object that dispatched the event.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">type</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
                    

                    

                    <div class="param-description">
                        <p>The event type.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">params</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
                    

                    

                    <div class="param-description">
                        <p>An array containing any arguments that were passed to the Stage.update() method. For
     example if you called stage.update("hello"), then the params would be ["hello"].</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    


    
</div>

                
            </div>
        
    </div>
</div>

                    </div>
                </div>
            </div>
        </div>
    </div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>
